Add job suspend resume paths#29788
Add job suspend resume paths#29788scrappywyrm wants to merge 15 commits intoAzure:release-app-Microsoft.App-2024-08-02-previewfrom
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| Jobs.json | 2024-08-02-preview(9c0fa31) | 2024-03-01(main) |
| Jobs.json | 2024-08-02-preview(9c0fa31) | 2024-02-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L629:5 |
|
| The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L685:5 |
|
| The new version has a new read-only property 'runningState' in response that was not found in the old version. New: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L892:11 Old: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L780:11 |
️❌LintDiff: 4 Errors, 6 Warnings failed [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-08 | package-preview-2024-08(9c0fa31) | package-preview-2024-08(release-app-Microsoft.App-2024-08-02-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L630 |
RPC-Async-V1-11, RPC-Async-V1-14 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L670 |
|
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L686 |
RPC-Async-V1-11, RPC-Async-V1-14 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L726 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L638 |
||
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L641 |
||
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L644 |
||
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L694 |
||
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L697 |
||
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L700 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L186 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L206 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L245 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L281 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:triggerType. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L281 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:triggerType. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L281 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:replicaTimeout. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L281 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:cronExpression. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L281 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:maxExecutions. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L281 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L307 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L367 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L383 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L421 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L475 |
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L27 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L30 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L66 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L69 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L72 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L108 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L111 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L117 |
|
| The summary and description values should not be same. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L140 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L149 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L152 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L167 |
|
| The summary and description values should not be same. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L206 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L215 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L218 |
|
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L224 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
RESPONSE_SCHEMA_NOT_IN_SPEC |
Response statusCode 200 for operation Jobs_Resume has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L655:22 ExampleUrl: preview/2024-08-02-preview/examples/Jobs_Resume.json#L8:16 |
RESPONSE_SCHEMA_NOT_IN_SPEC |
Response statusCode 200 for operation Jobs_Suspend has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L711:22 ExampleUrl: preview/2024-08-02-preview/examples/Jobs_Suspend.json#L8:16 |
RESPONSE_SCHEMA_NOT_IN_SPEC |
Response statusCode 200 for operation Jobs_Resume has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L655:22 ExampleUrl: preview/2024-08-02-preview/examples/Jobs_Resume.json#L8:16 |
RESPONSE_SCHEMA_NOT_IN_SPEC |
Response statusCode 200 for operation Jobs_Suspend has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Microsoft.App/preview/2024-08-02-preview/Jobs.json#L711:22 ExampleUrl: preview/2024-08-02-preview/examples/Jobs_Suspend.json#L8:16 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json
Show resolved
Hide resolved
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json
Show resolved
Hide resolved
fix runningState and add azure-asyncoperation
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json
Outdated
Show resolved
Hide resolved
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json
Outdated
Show resolved
Hide resolved
|
You have similar flagged errors in your LintDiff validations here : https://github.com/Azure/azure-rest-api-specs/pull/29788/checks?check_run_id=27473684037 |
cb2178b to
4117847
Compare
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
4117847 to
cb2178b
Compare
70d583a to
c7ab3d8
Compare
19f33c0 to
2ac7e6c
Compare
…job-suspend-resume
|
cc: @raosuhas hi, could you please take a look at the recent changes? thank you!! |
...tion/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Resume.json
Outdated
Show resolved
Hide resolved
|
i think overall looks good, maybe also update the history.rst file and also add tests |
thanks @smzeng ....history.rst and tests are for cli PRs i believe? |
youre totally right, thats my bad haha. No wonder i couldn't find the file when i tried to link it earlier. Looks good then! |
…job-suspend-resume
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json
Outdated
Show resolved
Hide resolved
|
Change will be added to next preview api-version |
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.